/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package logmatcher.analyzers;

/**
 *  Inteface of anything what can be matched.
 */
public interface MatchingElement {
    //~ Methods --------------------------------------------------------------------------------------------------------

    /**
     *  Checks another message.
     *
     *  @param message Message to be checked
     */
    void check(String message);


    /**
     *  Returns id of the element.
     *
     *  @return id of the element
     */
    String getId();


    /**
     *  Starts the analysis.
     */
    void start();


    /**
     *  Stops the analysis.
     */
    void stop();


    /**
     *  Tells if matching is complete.
     *
     *  @return true is matching is complete, false if not
     */
    boolean isFinished();


    /**
     *  Tells if the analysis is successful.
     *
     *  @return true if the analysis is successful, false if not
     */
    boolean isSuccess();
}
